Package com.cisco.pt.ipc.sim.impl
Class ParserViewImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ParserViewImpl
- All Implemented Interfaces:
IPCObject,ParserView
Information provided by the PKI file:
\class ParserView
\brief ParserView handles and manipulates parser views.
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionParserViewImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddCommand(String mode, String command, boolean bAll, ViewCommandAction action) Information provided by the PKI file:voidInformation provided by the PKI file:getIncludeCommandForMode(String mode, String command) Information provided by the PKI file:getIncludeCommandForModeAt(String mode, int index) Information provided by the PKI file:intInformation provided by the PKI file:getModeAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:voidInformation provided by the PKI file:booleanisCommandAdded(String commandStr) Information provided by the PKI file:booleanremoveCommand(String mode, String command, ViewCommandAction action) Information provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
ParserViewImpl
public ParserViewImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
setSecret
Information provided by the PKI file:
\brief Sets the secret. \param secretStr, the secret.- Specified by:
setSecretin interfaceParserView- Parameters:
secretStr- Takes in a parameter of secretStr
-
getSecret
Information provided by the PKI file:
\brief Returns the secret. \return string, the secret.- Specified by:
getSecretin interfaceParserView- Returns:
- String Returns a String
-
addCommand
Information provided by the PKI file:
\brief Adds the specified command to the view. \param mode, the mode to add the command to. Valid modes: user, enable, global. \param command, the command of interest. \param bAll, true to include all, false to not include all. \param action, the view command action. Actions: eViewCommandInclude = 0, eViewCommandExclude = 1, eViewCommandIncludeExclusive = 2 \return bool, true if successful, otherwise false.- Specified by:
addCommandin interfaceParserView- Parameters:
mode- Takes in a parameter of modecommand- Takes in a parameter of commandbAll- Takes in a parameter of bAllaction- Takes in a parameter of action- Returns:
- boolean Returns a boolean
-
removeCommand
Information provided by the PKI file:
\brief Removes the specified command from the view. \param mode, the mode to remove the command from. Valid modes: user, enable, global. \param command, the command of interest. \param action, the view command action. Actions: eViewCommandInclude = 0, eViewCommandExclude = 1, eViewCommandIncludeExclusive = 2 \return bool, true if successful, otherwise false.- Specified by:
removeCommandin interfaceParserView- Parameters:
mode- Takes in a parameter of modecommand- Takes in a parameter of commandaction- Takes in a parameter of action- Returns:
- boolean Returns a boolean
-
getModeCount
public int getModeCount()Information provided by the PKI file:
\brief Returns the number of modes. \return int, the number of modes.- Specified by:
getModeCountin interfaceParserView- Returns:
- int Returns a int
-
getModeAt
Information provided by the PKI file:
\brief Returns the mode at the specified index. \param index, the index of the mode of interest. \return string, mode at the specified index.- Specified by:
getModeAtin interfaceParserView- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
getIncludeCommandForModeCount
Information provided by the PKI file:
\brief Returns the number of include commands for the specified mode. \param mode, the mode of interest. Valid modes: user, enable, global. \return int, the number of include commands for the specified mode.- Specified by:
getIncludeCommandForModeCountin interfaceParserView- Parameters:
mode- Takes in a parameter of mode- Returns:
- int Returns a int
-
getIncludeCommandForModeAt
Information provided by the PKI file:
\brief Returns the include command in the specified mode at the specified index. \param mode, the mode of interest. Valid modes: user, enable, global. \param index, the index of the include command of interest. \return pair<string, bool>, the include command and a boolean value that is true if included in all, otherwise false.- Specified by:
getIncludeCommandForModeAtin interfaceParserView- Parameters:
mode- Takes in a parameter of modeindex- Takes in a parameter of index- Returns:
- Pair<String, Boolean> Returns a Pair<String, Boolean>
-
getIncludeCommandForMode
Information provided by the PKI file:
\brief Returns the include command in the specified mode with the specified command. \param mode, the mode of interest. Valid modes: user, enable, global. \param command, the command of interest. \return pair<string, bool>, the include command and a boolean value that is true if included in all, otherwise false.- Specified by:
getIncludeCommandForModein interfaceParserView- Parameters:
mode- Takes in a parameter of modecommand- Takes in a parameter of command- Returns:
- Pair<String, Boolean> Returns a Pair<String, Boolean>
-
incrementUserCount
public void incrementUserCount()Information provided by the PKI file:
\brief Increments the number of users.- Specified by:
incrementUserCountin interfaceParserView
-
decrementUserCount
public void decrementUserCount()Information provided by the PKI file:
\brief Decrements the number of users.- Specified by:
decrementUserCountin interfaceParserView
-
getUserCount
public int getUserCount()Information provided by the PKI file:
\brief Returns the number of users. \return int, the number of users.- Specified by:
getUserCountin interfaceParserView- Returns:
- int Returns a int
-
isCommandAdded
Information provided by the PKI file:
\brief Returns true if the specified command is already added to this view, otherwise false. \param commandStr, the command string to use. \return bool, true if the specified command is already added to this view, otherwise false.- Specified by:
isCommandAddedin interfaceParserView- Parameters:
commandStr- Takes in a parameter of commandStr- Returns:
- boolean Returns a boolean
-